13 March 2025

REST Services

The new and updated REST Services for the 4.47 release are detailed in the tables below.

  • CENTURY

  • Fund Manager (Experimental)

    Fund Manager is an experimental feature and should be considered a preview of ongoing work to replicate existing functionality in ebs: central.
CENTURY
Header Business Impact

New REST services for CENTURY

New REST services for the integration with CENTURY are as follows:

  • GET service /CenturyDetails/{id} has been created to retrieve CENTURY details records.

  • PUT service /CenturyDetails/{id} has been created to update course and event records to be included in the CENTURY integration.

  • POST service /CenturyDetails has been created to identify and describe course and event records to be included in the CENTURY integration.

  • DELETE service /CenturyDetails/{id} has been created to remove CENTURY details records.

Fund Manager
Header Business Impact

Integrations user is able to perform various actions using the new Fund Manager APIs.

An integrations user is able to perform the following actions using the new Fund Manager APIs:

  • Retrieve a list of funds

  • Retrieve a single fund record

  • Update a fund

  • Delete a single fund record

  • Retrieve and view list of learners on a fund

  • Create a fund

  • Assign or add a set of learners to a fund

The image below shows the new Fund Manager APIs in the ebs REST Documentation.

Integrations user is able to perform various actions using the new Reference Data APIs.

An integrations user is able to perform the following actions using the new Reference Data APIs:

  • Retrieve list of Funding Years defined in ebs reference data

  • Retrieve list of Verifiers defined in ebs reference data

  • Retrieve list of LSC Verifiers defined in ebs reference data

The image below shows the new Reference Data APIs in the ebs REST Documentation.

Integrations user is able to perform various actions using the new Learners APIs.

An integrations user is able to perform the following actions using the new Learners APIs:

  • Retrieve list of enrolled learners

  • Query and retrieve a list of courses a learner is attached to.

The image below shows the new Learners APIs in the ebs REST Documentation.

Integrations user is able to perform various actions using the new Staff APIs.

An integrations user is able to perform the following actions using the new Learners APIs:

  • Retrieve list of staff members

The image below shows the new Staff APIs in the ebs REST Documentation.

Integrations user is able to perform various actions using the new Fund Manager APIs.

An integrations user is able to perform the following actions using the new Fund Manager APIs:

  • Retrieve funds with a linked role

  • Create funds with a linked role

  • Update funds with a linked role

  • Delete funds with a linked role

Integrations user is able to perform various actions using the new Fund Manager APIs.

An integrations user is able to perform the following actions using the new Fund Manager APIs:

  • Delete an assessment header

  • Create an assessment header

  • Update an assessment header

  • Retrieve single or multiple assessment headers

Integrations user is able to perform various actions using the new Fund Manager APIs.

An integrations user is able to perform the following actions using the new Fund Manager APIs:

  • Delete delivered plan items

  • Create delivered plan items

  • Update delivered plan items

  • Retrieve delivered plan items

Integrations user is able to perform various actions using the new Fund Manager APIs.

An integrations user is able to perform the following actions using the new Fund Manager APIs:

  • Retrieve plan items

  • Create plan items

  • Update plan items

  • Delete plan items

Integrations user is able to perform various actions using the new Fund Manager APIs.

An integrations user is able to perform the following actions using the new Fund Manager APIs:

  • Retrieve a single learner on a fund

  • Delete a single learner on a fund

Integrations user is able to perform various actions using the new Reference Data APIs.

An integrations user is able to retrieve a list of Assessment Types from Reference Data.

Ability to stop users from retrieving, creating, updating, or deleting.

 

Fund Manager Admin can perform retrieve, create, update, or delete operations on assessments when linked role is not set, current behaviour, on the fund or when linked role is set to specific value on the fund, and I have given linked role.

For more information on the REST services, go to ebs REST Documentation.